Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docker): update env vars for resolver priority order #199

Merged
merged 2 commits into from
Sep 9, 2024

Conversation

dtfiedler
Copy link
Collaborator

@dtfiedler dtfiedler commented Sep 9, 2024

These are to configure the resolution order via docker compose

Related: #189

These are to configure the reesolution order via docker compose
Copy link
Contributor

coderabbitai bot commented Sep 9, 2024

Walkthrough

Walkthrough

This pull request updates the docker-compose.yaml configuration file by modifying the environment variables for a service. The TRUSTED_ARNS_RESOLVER_URL has been changed to an empty value, and several new environment variables have been added, enhancing the configuration options for resolver behavior and caching mechanisms.

Changes

File Change Summary
docker-compose.yaml - Modified TRUSTED_ARNS_RESOLVER_URL from a default HTTPS URL to an empty value.
- Added TRUSTED_ARNS_GATEWAY_URL, ARNS_RESOLVER_PRIORITY_ORDER, ARNS_CACHE_TTL_SECONDS, and ARNS_CACHE_MAX_KEYS.
src/config.ts - Modified TRUSTED_ARNS_RESOLVER_URL to use env.varOrUndefined instead of env.varOrDefault.

Possibly related PRs

Tip

New features

Walkthrough comment now includes:

  • Possibly related PRs: A list of potentially related PRs to help you recall past context.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

  • Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 897a515 and 1d1fd3f.

Files selected for processing (2)
  • docker-compose.yaml (1 hunks)
  • src/config.ts (1 hunks)
Additional comments not posted (6)
docker-compose.yaml (5)

74-74: Verify the intention behind the empty value for TRUSTED_ARNS_RESOLVER_URL.

The modification to set TRUSTED_ARNS_RESOLVER_URL to an empty value could potentially disable the resolver unless other configurations are set. Please confirm that this change is intentional and document the expected behavior or fallback mechanisms.


75-75: Approve the addition of TRUSTED_ARNS_GATEWAY_URL but verify the URL format.

The addition of TRUSTED_ARNS_GATEWAY_URL with a default URL provides a fallback or alternative gateway URL. Please ensure that the URL is correctly formatted and resolves as expected.


76-76: Approve the addition of ARNS_RESOLVER_PRIORITY_ORDER.

The addition of ARNS_RESOLVER_PRIORITY_ORDER enhances configurability and allows for more controlled resolution of services. Please ensure that the order and its impact are well-documented.


77-77: Approve the addition of ARNS_CACHE_TTL_SECONDS.

The addition of ARNS_CACHE_TTL_SECONDS helps in managing cache expiration and can improve performance by controlling how long data remains in the cache. Please ensure that the TTL settings and their impact on caching behavior are well-documented.


78-78: Approve the addition of ARNS_CACHE_MAX_KEYS.

The addition of ARNS_CACHE_MAX_KEYS helps in managing cache size and can prevent excessive memory usage by controlling the maximum number of keys stored in the cache. Please ensure that these settings and their impact on cache size management are well-documented.

src/config.ts (1)

287-287: Verify the change in handling TRUSTED_ARNS_RESOLVER_URL.

The modification to handle TRUSTED_ARNS_RESOLVER_URL with varOrUndefined instead of varOrDefault could impact the application's behavior when the environment variable is not defined. Please confirm that this change is intentional and document how the application should behave in cases where the variable is undefined.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Sep 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.53%. Comparing base (fc1c043) to head (1d1fd3f).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #199      +/-   ##
===========================================
- Coverage    68.53%   68.53%   -0.01%     
===========================================
  Files           32       32              
  Lines         7796     7795       -1     
  Branches       438      438              
===========================================
- Hits          5343     5342       -1     
  Misses        2452     2452              
  Partials         1        1              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

If this url is provided, the composite arns resolver will try and use it. Since the resolver is not enabled by default we should remove this so it is not used.
@djwhitt djwhitt merged commit 21f23bf into develop Sep 9, 2024
5 checks passed
@djwhitt djwhitt deleted the PE-6597-on-demand-envs branch September 9, 2024 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants